Support string.Format culture info parameter analyzer & code fixer #25

Jack251970 · 2025-03-11T12:51:34Z

Important

I have thoroughly tested the generator diagnostics and code fixes related to the old translation and I believe them are ready to move to production.

Support string.Format culture info parameter analyzer & code fixer

Test

Now fixing them can work well.

_ = Context.API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_name");
_ = API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_name");

_ = string.Format(Context.API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_used"), string.Empty, null, string.Empty);
_ = string.Format(API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_used"), string.Empty, null, string.Empty);

_ = string.Format(CultureInfo.CurrentCulture, Context.API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_used"), string.Empty, null, string.Empty);
_ = string.Format(CultureInfo.CurrentCulture, API.GetTranslation("flowlauncher_plugin_localization_demo_plugin_used"), string.Empty, null, string.Empty);

coderabbitai · 2025-03-11T12:54:57Z

📝 Walkthrough

Walkthrough

This pull request makes minor formatting adjustments in the localization analyzers. In the OldGetTranslateAnalyzer class, an extra leading space before the return statement in the GetArgumentInvocationExpression method was removed. In the OldGetTranslateAnalyzerCodeFixProvider class, the null-conditional operator was removed from method calls on root (after an explicit null-check) in the FixOldTranslation method. No changes affect the public API or overall control flow.

Changes

Files	Change Summary
Flow.Launcher...OldGetTranslateAnalyzer.cs	Minor formatting change: Removed extra space in the return statement within the `GetArgumentInvocationExpression` method while preserving functionality.
Flow.Launcher...OldGetTranslateAnalyzerCodeFixProvider.cs	Modified `FixOldTranslation`: Removed the null-conditional operator, calling methods on `root` directly after confirming it is non-null.

Possibly related PRs

Replace more strings with constants #19: Involves modifications to the OldGetTranslateAnalyzerCodeFixProvider class for enhanced handling of localization keys.

Suggested labels

enhancement

Suggested reviewers

Yusyuriv

Poem

In the code garden, a little tweak unfurls,
Spaces trimmed neatly as logic whirls,
A rabbit hops by with a knowing gaze,
Fixing the lines in its subtle phrase,
Hop along, dear coder, in these refined arrays!

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzer.cs (1)

43-60: Iterating over arguments to detect nested translations.

This expanded check allows detecting any translation calls within string.Format arguments. Nicely handles reporting a diagnostic when found. Consider whether multiple translations in the same string.Format are a valid scenario that might require more than a single diagnostic.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6171e92 and 780eb9f.

📒 Files selected for processing (5)

Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzer.cs (4 hunks)
Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (5 hunks)
Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (3 hunks)
Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (1 hunks)
Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzer.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build

🔇 Additional comments (20)

Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (6)

52-53: Gracefully handling null root.

It's good to see a concise check for a null root to prevent downstream exceptions. If possible, confirm whether you expect root to be non-null in most scenarios. If it's always expected to be non-null, consider logging a debug message or clarifying why this condition might be triggered, so that potential anomalies can be caught earlier.

58-58: Safer retrieval with FirstOrDefault.

Switching from First() to FirstOrDefault() prevents potential InvalidOperationException if no matching node is found. This aligns well with the subsequent null checks.

60-60: Early return when invocation expression is null.

Returning the original document when invocationExpr is null is a clean fallback. This helps avoid unnecessary processing down the line.

64-83: Iterating over all arguments.

Looping through each argument to handle both literal and nested invocation scenarios is robust. Note that the logic currently stops after handling the first matching argument. If future requirements call for detecting multiple translations in the same call, consider extending the loop to handle them all.

113-113: Comparing count with == 1 instead of using a pattern.

Using == 1 for checking the argument count is more typical and explicit than pattern matching for older compilers. This improves clarity.

126-130: New parameter and logic for string formatting.

Adding the int translationArgIndex parameter clarifies which argument contains the translation call. Skipping arguments up to translationArgIndex + 1 is a neat approach. However, if multiple translation calls exist, only the first is handled. Consider whether a multi-invocation scenario should be supported.

Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzer.cs (14)

14-14: Region annotation.

No functional changes here; purely organizational. Nothing to address.

27-27: Region end.

Again, purely organizational. No concerns.

29-29: Region annotation.

No functional changes here; purely organizational. Nothing to address.

37-37: Clarifying comment for format string call.

This comment clarifies the logic. No concerns.

40-40: Additional comment explaining first branch detection.

Clear explanation of matching calls to string.Format. No issues flagged.

62-62: Comment for second branch.

No functional changes, purely descriptive.

79-80: Enhanced argument retrieval with an index.

Adding an overload to retrieve additional arguments beyond the translation call is helpful. This is a good step toward more dynamic handling of arguments.

82-101: Implementing IsParentFormatStringCall to walk up the syntax tree.

Walking up the tree to check for an enclosing format call is a clean approach. Implementation seems robust, and short-circuiting when you find a matching symbol is efficient.

104-105: Check for string.Format method.

Your conditions for recognizing string.Format are concise and correct. No issues here.

107-108: Retrieving nested argument invocation.

Using a helper method to fetch nested invocation expressions by index is consistent with the rest of your design. This improves readability.

112-112: Using OldLocalizationMethodName for translation calls.

Straightforward string check is aligned with the approach used elsewhere. No remarks.

125-125: Region boundary annotation.

Purely organizational. No functional changes.

126-126: Final region boundary.

Again, organizational. Nothing to address.

128-128: Concluding region.

No functional changes. Skipping details.

Jack251970 added 5 commits March 11, 2025 19:30

Support string.Format culture info parameter analyzer

f630fc7

Improve code quality

f12be6d

Support string.Format culture info parameter code fixer

8805539

Improve code quality

6cdf3fd

Fix little blank

780eb9f

github-actions bot assigned Jack251970 Mar 11, 2025

Jack251970 requested a review from Yusyuriv March 11, 2025 12:52

Jack251970 added the enhancement New feature or request label Mar 11, 2025

coderabbitai bot reviewed Mar 11, 2025

View reviewed changes

Yusyuriv approved these changes Mar 15, 2025

View reviewed changes

Jack251970 merged commit 1b056cf into main Mar 15, 2025
3 checks passed

Jack251970 deleted the old_translation1 branch March 15, 2025 06:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Support string.Format culture info parameter analyzer & code fixer #25

Support string.Format culture info parameter analyzer & code fixer #25

Uh oh!

Jack251970 commented Mar 11, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 11, 2025

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Support string.Format culture info parameter analyzer & code fixer #25

Support string.Format culture info parameter analyzer & code fixer #25

Uh oh!

Conversation

Jack251970 commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Support string.Format culture info parameter analyzer & code fixer

Test

Uh oh!

coderabbitai bot commented Mar 11, 2025

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Jack251970 commented Mar 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)